Payment Gateways

When creating and configuring paymentThe verification of a money transaction in a website shopping situation. The e-commerce system most often needs a verification for a payment, in order to create the actual purchase order and complete the shopping workflow. methods in EPiServer Commerce, there are three componentsA plug-in that is added to the client side application. Components are used for integration purposes, for example to enable editors to do drag-and-drop of multiple files from their computers to the file manager in EPiServer CMS. that need to be created or re-used as well as configured: Payment Types, Payment Gateways and Payment Methods.

Payment Types – Payment types are classes which contain the properties of a particular payment type. For example, a credit card payment type contains credit card number, card expiration dateUsed if this order is tied to a recurring payment plan for subscription-based transactions., card type, etc. All payment types inherit from the abstract class Payment. The most common payment types are already built-in to EPiServer Commerce:

• Credit card
• Cash Card
• Gift Card
• Invoice

In addition, a generic "OtherPayment" class type is included in EPiServer Commerce. Payment types are meta classes.

Payment Gateways – Payment gateways provide an interface to the system which provides payment processing. A payment type is passed to the payment gateway and the gateway executes the payment transaction with the payment system (e.g. PayPal). One payment type is associated with each payment gateway.

Payment Methods – Payment methods contain information about the way the customer views a payment option and has a payment gateway associated with it.

Using Built-In Payment Gateways

To setup payments using a built-in payment gateway, go to Administration, Language (English, German, Spanish, etc.).

The Payment Methods window appears.

If selecting English (US) on the sample site the following payment methods will be available by default:

• Gift Card
• Pay By Credit Card
• Exchange Payment
• Pay By Phone
• Credit on Account

To create a new Payment Method, click on New to open the Payment Method Edit screen.

Here is an explanation of some of the gateway properties:

• ID – the system-assigned unique identifier for the payment gateway
• Name – the name to be displayed to the user1. The number of unique IP adresses that visited this page/URL during a specified period. 2. A person using a product, or someone visiting a community website either anonymously or as a registered member.
• Description – a description that can be displayed to the user
• System Keyword – the unique name for each instance of the gateway; new non-unique keywords will not save to the database. This is not be editable after a gateway is initially created
• Language – allows a specific language to be specified for the payment gateway
• Class Name – name of the gateway class to be associated with the payment
• Sort Order – specifies the order of the payment method on the list of payment methods page
• IsActive – specify whether or not the payment method is active\
• IsDefault – specific whether or not the payment method is the default one
• Supports Recurring – specify whether this payment methods supports recurring payments, such as for subscriptions

• Restricted Shipping Methods – Restricted shipping methods is not fully implemented out of the box and requires a developer to complete the functionality.

Click OK to save the Payment Method. The payment method will appear in the list of Payment Methods.

Setting up Payment Methods using nSoftware Provided Payment Gateways

EPiServer Commerce supports multiple payment gateways out of the box using nSoftware where new payment methods can easily be set up by end-users.

1. To enable nSoftware supported gateways, create a new payment method.
2. Enter in a Name, such as nSoftware or anything else.
3. Enter in a Description.
4. Enter in the System Keyword as "ICharge".
5. Select a Language from the drop-down menu.
6. Select the Class Name "Mediachase.Commerce.Plugins.Payment.ICharge.IChargeGateway".
7. Select "Yes" for IsActive.
8. Change the Sort Order, IsDefault, Supports Recurring as needed.
9. Click OK to save changes.

Once created, click on the payment gateway again to go back to the Payment Method Edit page. Click on the Parameters tab.

The Configure IBiz E-Payment Integrator Component appears and you can select from the Gateway drop-down menu several dozen of the most popular payment gateways will appear. Depending on the gateway you select, such as Authorize.Net, the Configuration Parameters will change. Enter in your credentials and other relevant information to activate the gateway and click OK.

Editing Payment Methods

To edit an existing payment method, click on the Notepad icon next to the Delete icon.

The ID is auto-generated. Every field can be changed except System Keyword. After you are satisfied with your changes, click on OK.

Deleting Payment Methods

To delete Payment Methods, click on the X icon next to the payment method name and click OK when the popup appears. To delete multiple payment methods at once, check mark each payment method you want to delete, then click on More Actions --> Delete on the drop-down menu. Click OK when the popup appears.

Version: EPiServer Commerce 1 R2 SP2| Last updated: 2012-09-20 | Copyright © EPiServer AB | Send feedback to us